home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Languages / Mops 2.5 / Quick Edit ƒ / Quick Edit ReadMe < prev    next >
Encoding:
Text File  |  1994-11-05  |  12.4 KB  |  330 lines  |  [TEXT/MSET]
  1.  
  2. This information has been updated for version 2.5
  3.  
  4. **** WHAT THIS IS ****
  5.  
  6. Quick Edit (QE) is a programmer's source code editor intended for use
  7. with Mops, Michael's Object Oriented Programming System, and System 7.
  8. Typed Mops commands can be executed directly from an editor window, thus 
  9. avoiding copy-switch-paste.
  10.  
  11. Also included are a set of text files that comprise a Subject Sorted 
  12. Glossary for Mops definitions.
  13.  
  14.  
  15. **** NEW FOR VERSION 2.5 ****
  16.  
  17. • A Popup menu is now available that will list all classes and their methods
  18.   for the current window.  A ctrl-click in a QE window that contains Mops source
  19.   code will yield the menu.  The menu slection will cause a jump to the
  20.   source code for the class or method.
  21.  
  22. • We now use a proper programmer's screen font that clearly distinguishes
  23.   characters that are ambiguous with the Monaco font.
  24.  
  25. • Fixed a minor bug that caused scrollbars to not always activate.
  26.  
  27.  
  28.  
  29. **** WHAT YOU NEED TO USE QUICK EDIT ****
  30.  
  31. 1) System 7.x
  32.  
  33. 2) Mops (Michael's Object Oriented Programming System).
  34.  
  35. 3) The provided Mops Glossary file.
  36.  
  37.  
  38. Actually, 1) and 2) are not absolutely required as Quick Edit will function
  39. quite well as a stand-alone text processor without System 7 or Mops.  In that
  40. case you don't need 3) either.
  41.  
  42.  
  43. **** HOW TO USE QUICK EDIT ****
  44.  
  45. 1) Launch both Mops and Quick Edit.
  46.  
  47. 2) Now you should be able to execute typed Mops instructions from a QE
  48. window as if you were typing into the Mops window.  The major difference
  49. being that what you type can be saved as a (QE) text file.  Remember that
  50. you must use the enter key, not the return key, to execute commands.  
  51.  
  52.  
  53. **** ACTIVE GLOSSARY ****
  54.  
  55.   ***IMPORTANT***
  56.   You must keep the file "Mops Glossary" in the same folder as Quick Edit.
  57.  
  58.   While using QE it is possible to summon the glossary to look up a
  59.   definition in either of 2 ways.  First, you may highlight a word in a
  60.   QE window and then invoke the Mops/Glossary menu command (or
  61.   command-Y).  If found in the glossary, the word and its definition
  62.   will appear in a special window.  A second way to use the glossary
  63.   is to just invoke the Mops/Glossary menu command and then begin
  64.   typing the word that you wish to look up.  MacForth users will recognize
  65.   this as the Online Glossary feature from the Sibley Editor.
  66.   
  67.   You may copy text from the Active Glossary.
  68.   
  69.   For each definition in the Active Glossary we have the stack effect
  70.   immediately to the right of the name.  Further to the right, on the same
  71.   line, we have the Subject Name and File Name (the name of the Mops file
  72.   that contains the source code for the word) in SubjectName/FileName format.
  73.   
  74.   We have included a file, Stack Notation, to define the stack effect
  75.   notation used here.
  76.   
  77.   For most subjects we have a Subject Glossary file in the folder Subject 
  78.   Glossary.  In these files you will find all related words grouped together 
  79.   in a logical manner by function, rather than by ASCII order.  I find
  80.   that printing all of the Subject Glossary files and placing them in a
  81.   hole-punch binder with index tabs is an excellent way to keep a quick
  82.   reference.  You can also print the ASCII sorted glossary if you want,
  83.   it's just a text file, but it is really intended for active use with QE.
  84.   
  85.   We have included a file, Mops File Index, that is a quick reference to
  86.   the folder location of all the major files in the Mops release set.
  87.   So, from the Active Glossary you can obtain the source file name, see
  88.   where the source file is located from the Mops File Index, and then
  89.   open the source file to see the actual definition.  Note that one can
  90.   now easily open the source for already compiled code simply by
  91.   highliting a word in QE and invoking the Mops/Open Source menu command
  92.   (command-1), as long as Mops itself is also running.
  93.   
  94.   You may delete and add to the glossary yourself, but only if you open
  95.   the file "Mops Glossary" as a normal edit file, not as it is opened
  96.   as the QE glossary window.  Added definitions MUST be in ASCII order
  97.   and begin in the first column on a new line.  Only definition names may
  98.   begin in the first column.
  99.  
  100. **** SUBJECT GLOSSARY ****
  101.  
  102.   ***IMPORTANT***
  103.   You must keep the folder "Subject Glossary" in the same folder as Quick Edit.
  104.   
  105.   We have included a set of normal text files that comprise a "Subject Sorted 
  106.   Glossary".  The purpose of these files is to allow the programmer to quickly
  107.   review the available word set for a given category of words.  This avoids 
  108.   having to read the entire Glossary (which is ascii sorted) in order to find
  109.   out what is available.
  110.  
  111.   You can directly open any of these files via menu access to the Subject 
  112.  (sorted) Glossary.  Under the Mops menu.  
  113.  
  114. **** TIPS ****
  115.  
  116. Position both the Mops window and your current QE window so both are
  117. visible.
  118.  
  119. Pressing enter will execute either just the selected range, or if there
  120. is no selection the entire line will be executed.  Multiple lines or an
  121. entire file may be executed this way.
  122.  
  123. Pressing enter will normally advance the cursor to the end of the next
  124. line.  Hold down the option key to keep the cursor on the same line.
  125.  
  126. Change the file Mops.paths to include the directory that your QE files
  127. are in and you will be able to use the QE menu commands Load… ,
  128. Save&Load…,  and Save&Reload….
  129.  
  130.  
  131. **** ABOUT QUICK EDIT ****
  132.  
  133. Quick Edit is written in MacForth and is, for the large part, the 
  134. MacForth text editor, or Sibley Editor, with extensions to use Apple Events 
  135. for Mops communication.  I also added my favorite tweaks to the editor.  QE 
  136. behaves in a standard manner and so should be fairly easy to learn.  
  137. MacForth users will of course feel pretty much at home except for a few
  138. exceptions that are explained later.  
  139.  
  140. I wrote QE as a tool to make it easier for me to use Mops.  If one
  141. has a desire to explore Forth object oriented programming ( FOOP?
  142. Forth++? ), then a look at Mops is a must.  You will likely find that you
  143. will soon stop exploring and begin writing useful code at a very high
  144. level of productivity.
  145.  
  146.  
  147.  Doug Hoffman  28Mar92
  148.                  4Jun92 v1.1
  149.                  6Dec92 v1.2
  150.                  2Mar93 v1.3
  151.                 27Dec93 v2.4
  152.                 27Mar94 v2.4.1
  153.                 05Nov94 v2.5
  154.  
  155.  Compuserve  72310,1743
  156.  
  157.  565 Countryside Lane
  158.  Oakland, Michigan  48363-1401
  159.  
  160.  
  161.  
  162.  
  163.  
  164. **** DETAILS OF USING QUICK EDIT ****
  165.  
  166. Up to 20 files (windows) can be open at the same time.  The open QE file
  167. names will appear under the Windows menu and will be preceded by bullets
  168. if the files have unsaved changes.
  169.  
  170. There are several useful text search shortcuts that bypass the Find...
  171. dialog.  Option-Doubleclick on a word to find the first occurrence. A
  172. subsequent Command-G (Find Same) will then find the next occurrence.
  173. Any time a search fails a simple beep will be issued and the cursor will
  174. remain where it last was.  Command-Doubleclick on a word to do a backwards 
  175. search (i.e. attempt to find the first prior occurrence).  Option-
  176. Command-Doubleclick on a word to find the next occurrence.
  177.  
  178. If the Text Search dialog is summoned (via Command-F or the menu) any
  179. highlited text will automatically become the "Search for" parameter.  If
  180. no text was highlited then the prior "Search for" text will remain.
  181.  
  182. All searches begin at the current selection point and end at the end of
  183. the file.  If the Text Search dialog is used one can also search all
  184. files in the same directory as the open file.  Holding down the shift
  185. key when either summoning the Text Search dialog or doing a Find Same
  186. (Command-G) will cause the search to be initiated from the beginning of
  187. the file.
  188.  
  189. Command-` (Enter Search$) will enter the highlited text as the search
  190. string without summoning the Text Search dialog.  This is useful for
  191. "loading" some text to search for in one window and then moving to another 
  192. window to do the search.  A Command-Shift-G will start the search
  193. at the beginning of the file.  This can be handy.  Command-Shift-F will 
  194. also start the search at the beginning of the file, but will summon the
  195. Text Search dialog.
  196.  
  197. Up to 10 bookmarks can be set by pressing Command-Shift-J followed
  198. by a number (0 through 9).  One then jumps to these bookmarks by pressing 
  199. Command-J followed by pressing the corresponding single digit number key.
  200.  
  201. Modifier keys for cursor movement works as follows:
  202.  
  203. Option left/right        move cursor one word
  204. Option up/down            move one line
  205. Command left/right        move to beginning or end of line
  206. Command up/down            move to beginning or end of screen or prev/next screen
  207. Command-Option up/down    move to beginning or end of file
  208. Option-Delete            delete previous word
  209. Command-Backspace        delete to beginning of file
  210. Command-Delete            delete to end of file
  211.  
  212.  
  213.  
  214. MiniPrint...  is intended for use only with high resolution printers having 
  215. scalable fonts such as LaserWriters or the StyleWriter.  MiniPrinting 
  216. will print in a very small Helvetica font and allow for a paper savings 
  217. of 3-4 to 1 in most cases.  I find this useful for printing drafts
  218. and reducing the quantity of paper used.
  219.  
  220. If the printed page seems wrong, try using the Page Setup...  command and
  221. select portrait orientation at 100% scale.
  222.  
  223.  
  224. Note that cutting and pasting will normally delete and add extra spaces as 
  225. necessary in a fashion similar to WriteNow.  This feature is only activated 
  226. after text is highlited via a doubleclick and is then cut or copied.  Text 
  227. that is highlited via shift-extension or singleclick-drag will be cut and 
  228. pasted in the normal fashion.  
  229.  
  230. Also note that indents via tabs or spaces will be repeated on subsequent lines
  231. upon return unless the option key is pressed.  Auto-Indent is toggled
  232. from the menu.
  233.  
  234. In most word processors characters such as a period (.) are treated as a word 
  235. delimiter.  So doubleclicking something like " this.word " in most word 
  236. processors will only highlite this or word, depending upon where you first 
  237. clicked.  Also, in most word processors a whole word search on " this " will 
  238. hit on " this.word " and other compounds of " .this.  " which is not what I 
  239. want.  Since Forth does not treat a period as a delimiter, I have chosen to 
  240. have Quick Edit do likewise.  This behavior may be different from what you 
  241. are used to.
  242.  
  243. The Mops menu contains a few handy Mops commands that will clear the stack
  244. or forget the hilited word.
  245.  
  246. A multiple line indent/unindent command is also available in the Special
  247. menu.
  248.  
  249. Quick Edit does not word-wrap, but a highlited selection can be wrapped to
  250. fit in the current window by using the Edit menu Margin command.
  251.  
  252.  
  253. **** FONTS/PRINTING ****
  254.  
  255.  
  256. The window and printer font IDs and font sizes are now resources and so
  257. can be changed to suit.  You must use a resource editor.  I know this isn't 
  258. very Mac-like, but it was easy to implement (and we're all programmers 
  259. here, right?).  
  260.  
  261. The QEF1 resources affect things as follows:
  262.  
  263. RESOURCE ID        AFFECTS                        DEFAULT VALUE
  264.  
  265. 1                window font    ID                $00C8    Modified Monaco (MUST be mono-spaced)
  266. 2                window font size            $0009
  267.  
  268. 3                miniprint font ID            $0015    Helvetica
  269. 4                miniprint font size            $0007
  270.  
  271. 7                option mini font ID            $0016    Courier
  272. 8                option mini font size        $0007
  273.  
  274. Note that the window font MUST be mono-spaced.  But this is not a requirement 
  275. for the miniprint fonts.  In fact, the Helvetica default miniprint font, which 
  276. is proportionally spaced, is used to allow two columns per page due to the 
  277. relatively high character linear density.  
  278.  
  279. When selecting a file to miniprint from the standard file dialog, pressing
  280. the option key will yield a one-column monospace (Courier) page.  This
  281. may be desirable for printing that needs accurate alignment.  You only
  282. need press the option key momentarily at the instant of file selection.
  283.  
  284. All miniprinting will yield 105 lines per column (standard 81/2 x 11 inch 
  285. paper).  Note that the page numbers shown in the box upon mouse hits on the 
  286. vertical thumb scroll control don't necessarily correspond to the number of 
  287. printed pages.  
  288.  
  289.  
  290. **** OTHER FEATURES ****
  291.  
  292. • Mops/Edit File (command-=) menu command.  Hilite the name of a file and then invoke
  293.   this menu command.  The file will be opened.  Also works for module filenames
  294.   without having to first append ".txt".
  295.  
  296. • There is now an "AllWindows->Right" Windows menu command.  Useful for getting all
  297.   open editor windows off to one side so the Mops window can be viewed while still
  298.   in Quick Edit.
  299.  
  300.  
  301.  
  302.  
  303. **** PACKING LIST ****
  304.  
  305. The following is a list of all files that should be present in the 
  306. Quick Edit release set:
  307.  
  308. Quick Edit ReadMe
  309.  
  310. Mops Glossary
  311.  
  312. Quick Edit 2.5 (the application)
  313.  
  314. Stack Notation
  315.  
  316. Subject Glossary  (a folder)
  317.     Arithmetic
  318.     Compiler
  319.     Console
  320.     Control Structures
  321.     Events
  322.     Floating Point
  323.     Memory
  324.     OOP
  325.     QuickDraw
  326.     Stack
  327.     Strings
  328.     System
  329.     Toolbox 
  330.